<?php

/**
 * This is the model class for table "m_student_family".
 *
 * The followings are the available columns in table 'm_student_family':
 * @property integer $id
 * @property integer $student_id
 * @property string $family_type
 * @property integer $is_alm
 * @property string $name
 * @property string $home_phone
 * @property string $office_phone
 * @property string $mobile_phone
 * @property string $email_address
 * @property string $address
 * @property integer $priority_contact
 *
 * The followings are the available model relations:
 * @property MStudent $student
 */
class MStudentFamily extends CActiveRecord
{
	/**
	 * @return string the associated database table name
	 */
	public function tableName()
	{
		return 'm_student_family';
	}

	/**
	 * @return array validation rules for model attributes.
	 */
	public function rules()
	{
		// NOTE: you should only define rules for those attributes that
		// will receive user inputs.
		return array(
			array('student_id, family_type, is_alm, name', 'required'),
			array('student_id, is_alm, priority_contact', 'numerical', 'integerOnly'=>true),
			array('family_type', 'length', 'max'=>20),
			array('name, email_address', 'length', 'max'=>255),
			array('home_phone, office_phone, mobile_phone', 'length', 'max'=>100),
			array('address', 'safe'),
			// The following rule is used by search().
			// @todo Please remove those attributes that should not be searched.
			array('id, student_id, family_type, is_alm, name, home_phone, office_phone, mobile_phone, email_address, address, priority_contact', 'safe', 'on'=>'search'),
		);
	}

	/**
	 * @return array relational rules.
	 */
	public function relations()
	{
		// NOTE: you may need to adjust the relation name and the related
		// class name for the relations automatically generated below.
		return array(
			'student' => array(self::BELONGS_TO, 'MStudent', 'student_id'),
		);
	}

	/**
	 * @return array customized attribute labels (name=>label)
	 */
	public function attributeLabels()
	{
		return array(
			'id' => 'ID',
			'student_id' => 'Student',
			'family_type' => 'Family Type',
			'is_alm' => 'Is Alm',
			'name' => 'Name',
			'home_phone' => 'Home Phone',
			'office_phone' => 'Office Phone',
			'mobile_phone' => 'Mobile Phone',
			'email_address' => 'Email Address',
			'address' => 'Address',
			'priority_contact' => 'Priority Contact',
		);
	}

	/**
	 * Retrieves a list of models based on the current search/filter conditions.
	 *
	 * Typical usecase:
	 * - Initialize the model fields with values from filter form.
	 * - Execute this method to get CActiveDataProvider instance which will filter
	 * models according to data in model fields.
	 * - Pass data provider to CGridView, CListView or any similar widget.
	 *
	 * @return CActiveDataProvider the data provider that can return the models
	 * based on the search/filter conditions.
	 */
	public function search()
	{
		// @todo Please modify the following code to remove attributes that should not be searched.

		$criteria=new CDbCriteria;

		$criteria->compare('id',$this->id);
		$criteria->compare('student_id',$this->student_id);
		$criteria->compare('family_type',$this->family_type,true);
		$criteria->compare('is_alm',$this->is_alm);
		$criteria->compare('name',$this->name,true);
		$criteria->compare('home_phone',$this->home_phone,true);
		$criteria->compare('office_phone',$this->office_phone,true);
		$criteria->compare('mobile_phone',$this->mobile_phone,true);
		$criteria->compare('email_address',$this->email_address,true);
		$criteria->compare('address',$this->address,true);
		$criteria->compare('priority_contact',$this->priority_contact);

		return new CActiveDataProvider($this, array(
			'criteria'=>$criteria,
		));
	}

	/**
	 * Returns the static model of the specified AR class.
	 * Please note that you should have this exact method in all your CActiveRecord descendants!
	 * @param string $className active record class name.
	 * @return MStudentFamily the static model class
	 */
	public static function model($className=__CLASS__)
	{
		return parent::model($className);
	}
}
